Get a specific order

GET 
/orders/:orderId

Returns the order with the given id

Request

Path Parameters

orderId stringrequired

The id of the order to retrieve. This is the same as the id of the basket that was checked out.

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

id stringrequired

The id of the order

created object
providerOrders object[]required
A list of all providers that products have been purchased from.
Array [
id object
lineItems object[]required
A list of all line items included in the provider order.
Array [
id object
type object
The type of a line item. OneBasket supports many different product types that can be purchased.
productId object
totalPrice object
minorUnits int32required
currencyCode stringrequired
precision int32required
totalTax object
minorUnits int32required
currencyCode stringrequired
precision int32required
ticketing object
A ticketing line item represents a product that is related to ticketing.
type Models.Ticketing.TicketingTyperequired
Possible values: [TicketedEvent]
The type of ticketing product this line item represents
eventType Models.Ticketing.EventType
Possible values: [SportsMatch]
If a TicketEvent type, then this indicates what sort of ticketed event.
sportsMatch object
If the event type is 'SportsMatch', contains additional information about the line item's event
matchDate Instantrequired
The date of the match, including time
competition objectrequired
Which competition the match is part of
name stringrequired
The name of the competition (Premier League 2021, Champions League 2021, etc)
season stringrequired
The season of the competition (2019/20, 2020/21, etc)
competitionType stringrequired
The type of competition (Premier League, Champions League, etc)
hostTeam objectrequired
The home team
id stringrequired
The id of the team
name stringrequired
The name of the team
logoImageUrl string
The team crest
opponentTeam objectrequired
The away team
id stringrequired
The id of the team
name stringrequired
The name of the team
logoImageUrl string
The team crest
tickets object[]required
A list of tickets that have been added to the basket for this event.
Array [
id stringrequired
The id of the ticket
providerSeatId stringrequired
The id of the seat being purchased. This is the id that the provider uses to identify the seat.
seatCategory stringrequired
The seat category of the seat being purchased.
tariff stringrequired
The tariff of the seat being purchased.
section stringrequired
The section the seat is in
row stringrequired
The row the seat is in
seat stringrequired
The seat number
price objectrequired
The price of the ticket, including any taxes.
minorUnits int32required
currencyCode stringrequired
precision int32required
]
consumable object
A consumable line item represents a product that a human can consume (eat or drink).
quantity int32required
The number of instances of this product that was purchased.
unitPrice objectrequired
The price of a single instance of this product, including any taxes.
minorUnits int32required
currencyCode stringrequired
precision int32required
productGroupId string
Optional - The product group that the product belongs to. For consumables, this typically represents a menu.
kioskId string
Optional - The kiosk from which this product is being purchased from.
timestreamId string
Optional - The time stream that this product is being purchased within. For consumables, this typically represents a time period during an event, such as presales, early bird, half time, etc.
validUntil Instant
Optional - The time that this line item is valid until. This represents how long the current price of the line item is valid for. Pricing of products can change if they are in a time stream.
title stringrequired
The title of the product. For example, 'Cheeseburger'.
description string
The description of the product. For example, 'A delicious cheeseburger with a beef patty, cheese, lettuce, tomato, and onion.'
allergens string
The allergens that the product contains. For example, 'Gluten, Dairy, Eggs'.
image string
The image of the product.
calories int32
The calories of the product.
]
totalPrice object
minorUnits int32required
currencyCode stringrequired
precision int32required
totalTax object
minorUnits int32required
currencyCode stringrequired
precision int32required
deliveryMethods object[]required
A list of dilevery methods used to fulfil the order.
Array [
type stringrequired
Possible values: [KioskCollection]
The type of the delivery method
KioskCollection
type stringrequired
Possible values: [KioskCollection]
kioskId object
kioskName stringrequired
The name of the kiosk which the order can be collected from
collectionTime object
scannable object
Represents a scannable item that can be used to identify a customer's order.
type stringrequired
Possible values: [QrCode]
The type of scannable
QrCode
type stringrequired
Possible values: [QrCode]
data stringrequired
The data encoded in the QR code. Use this to generate the QR code.
]
]
events object[]required
A list of all events that have occurred for this order, across all providers. Events are ordered by time.
Array [
providerOrderId object
category object
eventTime object
receivedTime object
id stringrequired
The id of the event
]

Example (from schema)

{
  "id": "string",
  "created": "string",
  "providerOrders": [
    {
      "id": "string",
      "lineItems": [
        {
          "id": "string",
          "type": "Ticketing",
          "productId": "string",
          "totalPrice": {
            "minorUnits": 0,
            "currencyCode": "string",
            "precision": 0
          },
          "totalTax": {
            "minorUnits": 0,
            "currencyCode": "string",
            "precision": 0
          },
          "ticketing": {
            "type": "TicketedEvent",
            "eventType": "SportsMatch",
            "sportsMatch": {
              "matchDate": "string",
              "competition": {
                "name": "string",
                "season": "string",
                "competitionType": "string"
              },
              "hostTeam": {
                "id": "string",
                "name": "string",
                "logoImageUrl": "string"
              },
              "opponentTeam": {
                "id": "string",
                "name": "string",
                "logoImageUrl": "string"
              }
            },
            "tickets": [
              {
                "id": "string",
                "providerSeatId": "string",
                "seatCategory": "string",
                "tariff": "string",
                "section": "string",
                "row": "string",
                "seat": "string",
                "price": {
                  "minorUnits": 0,
                  "currencyCode": "string",
                  "precision": 0
                }
              }
            ]
          },
          "consumable": {
            "quantity": 0,
            "unitPrice": {
              "minorUnits": 0,
              "currencyCode": "string",
              "precision": 0
            },
            "productGroupId": "string",
            "kioskId": "string",
            "timestreamId": "string",
            "validUntil": "string",
            "title": "string",
            "description": "string",
            "allergens": "string",
            "image": "string",
            "calories": 0
          }
        }
      ],
      "totalPrice": {
        "minorUnits": 0,
        "currencyCode": "string",
        "precision": 0
      },
      "totalTax": {
        "minorUnits": 0,
        "currencyCode": "string",
        "precision": 0
      },
      "deliveryMethods": [
        {
          "type": "KioskCollection"
        }
      ]
    }
  ],
  "events": [
    {
      "providerOrderId": "string",
      "category": "Processing",
      "eventTime": "string",
      "receivedTime": "string",
      "id": "string"
    }
  ]
}

Loading...